home *** CD-ROM | disk | FTP | other *** search
/ Skunkware 5 / Skunkware 5.iso / man / man.n / exec.n < prev    next >
Encoding:
Text File  |  1995-07-17  |  11.3 KB  |  380 lines
  1. '\"
  2. '\" Copyright (c) 1993 The Regents of the University of California.
  3. '\" All rights reserved.
  4. '\"
  5. '\" Permission is hereby granted, without written agreement and without
  6. '\" license or royalty fees, to use, copy, modify, and distribute this
  7. '\" documentation for any purpose, provided that the above copyright
  8. '\" notice and the following two paragraphs appear in all copies.
  9. '\"
  10. '\" IN NO EVENT SHALL THE UNIVERSITY OF CALIFORNIA BE LIABLE TO ANY PARTY
  11. '\" FOR DIRECT, INDIRECT, SPECIAL, INCIDENTAL, OR CONSEQUENTIAL DAMAGES
  12. '\" ARISING OUT OF THE USE OF THIS DOCUMENTATION, EVEN IF THE UNIVERSITY OF
  13. '\" CALIFORNIA HAS BEEN ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
  14. '\"
  15. '\" THE UNIVERSITY OF CALIFORNIA SPECIFICALLY DISCLAIMS ANY WARRANTIES,
  16. '\" INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY
  17. '\" AND FITNESS FOR A PARTICULAR PURPOSE.  THE SOFTWARE PROVIDED HEREUNDER IS
  18. '\" ON AN "AS IS" BASIS, AND THE UNIVERSITY OF CALIFORNIA HAS NO OBLIGATION TO
  19. '\" PROVIDE MAINTENANCE, SUPPORT, UPDATES, ENHANCEMENTS, OR MODIFICATIONS.
  20. '\" 
  21. '\" $Header: /user6/ouster/tcl/man/RCS/exec.n,v 1.6 93/07/23 15:13:34 ouster Exp $ SPRITE (Berkeley)
  22. '\" 
  23. .\" The definitions below are for supplemental macros used in Tcl/Tk
  24. .\" manual entries.
  25. .\"
  26. .\" .HS name section [date [version]]
  27. .\"    Replacement for .TH in other man pages.  See below for valid
  28. .\"    section names.
  29. .\"
  30. .\" .AP type name in/out [indent]
  31. .\"    Start paragraph describing an argument to a library procedure.
  32. .\"    type is type of argument (int, etc.), in/out is either "in", "out",
  33. .\"    or "in/out" to describe whether procedure reads or modifies arg,
  34. .\"    and indent is equivalent to second arg of .IP (shouldn't ever be
  35. .\"    needed;  use .AS below instead)
  36. .\"
  37. .\" .AS [type [name]]
  38. .\"    Give maximum sizes of arguments for setting tab stops.  Type and
  39. .\"    name are examples of largest possible arguments that will be passed
  40. .\"    to .AP later.  If args are omitted, default tab stops are used.
  41. .\"
  42. .\" .BS
  43. .\"    Start box enclosure.  From here until next .BE, everything will be
  44. .\"    enclosed in one large box.
  45. .\"
  46. .\" .BE
  47. .\"    End of box enclosure.
  48. .\"
  49. .\" .VS
  50. .\"    Begin vertical sidebar, for use in marking newly-changed parts
  51. .\"    of man pages.
  52. .\"
  53. .\" .VE
  54. .\"    End of vertical sidebar.
  55. .\"
  56. .\" .DS
  57. .\"    Begin an indented unfilled display.
  58. .\"
  59. .\" .DE
  60. .\"    End of indented unfilled display.
  61. .\"
  62. '\"    # Heading for Tcl/Tk man pages
  63. .de HS
  64. .ds ^3 \\0
  65. .if !"\\$3"" .ds ^3 \\$3
  66. .if '\\$2'cmds'       .TH \\$1 1 \\*(^3 \\$4
  67. .if '\\$2'lib'        .TH \\$1 3 \\*(^3 \\$4
  68. .if '\\$2'tcl'        .TH \\$1 n \\*(^3 Tcl "Tcl Built-In Commands"
  69. .if '\\$2'tk'         .TH \\$1 n \\*(^3 Tk "Tk Commands"
  70. .if '\\$2'tclc'        .TH \\$1 3 \\*(^3 Tcl "Tcl Library Procedures"
  71. .if '\\$2'tkc'         .TH \\$1 3 \\*(^3 Tk "Tk Library Procedures"
  72. .if '\\$2'tclcmds'         .TH \\$1 1 \\*(^3 Tk "Tcl Applications"
  73. .if '\\$2'tkcmds'         .TH \\$1 1 \\*(^3 Tk "Tk Applications"
  74. .if t .wh -1.3i ^B
  75. .nr ^l \\n(.l
  76. .ad b
  77. ..
  78. '\"    # Start an argument description
  79. .de AP
  80. .ie !"\\$4"" .TP \\$4
  81. .el \{\
  82. .   ie !"\\$2"" .TP \\n()Cu
  83. .   el          .TP 15
  84. .\}
  85. .ie !"\\$3"" \{\
  86. .ta \\n()Au \\n()Bu
  87. \&\\$1    \\fI\\$2\\fP    (\\$3)
  88. .\".b
  89. .\}
  90. .el \{\
  91. .br
  92. .ie !"\\$2"" \{\
  93. \&\\$1    \\fI\\$2\\fP
  94. .\}
  95. .el \{\
  96. \&\\fI\\$1\\fP
  97. .\}
  98. .\}
  99. ..
  100. '\"    # define tabbing values for .AP
  101. .de AS
  102. .nr )A 10n
  103. .if !"\\$1"" .nr )A \\w'\\$1'u+3n
  104. .nr )B \\n()Au+15n
  105. .\"
  106. .if !"\\$2"" .nr )B \\w'\\$2'u+\\n()Au+3n
  107. .nr )C \\n()Bu+\\w'(in/out)'u+2n
  108. ..
  109. '\"    # BS - start boxed text
  110. '\"    # ^y = starting y location
  111. '\"    # ^b = 1
  112. .de BS
  113. .br
  114. .mk ^y
  115. .nr ^b 1u
  116. .if n .nf
  117. .if n .ti 0
  118. .if n \l'\\n(.lu\(ul'
  119. .if n .fi
  120. ..
  121. '\"    # BE - end boxed text (draw box now)
  122. .de BE
  123. .nf
  124. .ti 0
  125. .mk ^t
  126. .ie n \l'\\n(^lu\(ul'
  127. .el \{\
  128. .\"    Draw four-sided box normally, but don't draw top of
  129. .\"    box if the box started on an earlier page.
  130. .ie !\\n(^b-1 \{\
  131. \h'-1.5n'\L'|\\n(^yu-1v'\l'\\n(^lu+3n\(ul'\L'\\n(^tu+1v-\\n(^yu'\l'|0u-1.5n\(ul'
  132. .\}
  133. .el \}\
  134. \h'-1.5n'\L'|\\n(^yu-1v'\h'\\n(^lu+3n'\L'\\n(^tu+1v-\\n(^yu'\l'|0u-1.5n\(ul'
  135. .\}
  136. .\}
  137. .fi
  138. .br
  139. .nr ^b 0
  140. ..
  141. '\"    # VS - start vertical sidebar
  142. '\"    # ^Y = starting y location
  143. '\"    # ^v = 1 (for troff;  for nroff this doesn't matter)
  144. .de VS
  145. .mk ^Y
  146. .ie n 'mc \s12\(br\s0
  147. .el .nr ^v 1u
  148. ..
  149. '\"    # VE - end of vertical sidebar
  150. .de VE
  151. .ie n 'mc
  152. .el \{\
  153. .ev 2
  154. .nf
  155. .ti 0
  156. .mk ^t
  157. \h'|\\n(^lu+3n'\L'|\\n(^Yu-1v\(bv'\v'\\n(^tu+1v-\\n(^Yu'\h'-|\\n(^lu+3n'
  158. .sp -1
  159. .fi
  160. .ev
  161. .\}
  162. .nr ^v 0
  163. ..
  164. '\"    # Special macro to handle page bottom:  finish off current
  165. '\"    # box/sidebar if in box/sidebar mode, then invoked standard
  166. '\"    # page bottom macro.
  167. .de ^B
  168. .ev 2
  169. 'ti 0
  170. 'nf
  171. .mk ^t
  172. .if \\n(^b \{\
  173. .\"    Draw three-sided box if this is the box's first page,
  174. .\"    draw two sides but no top otherwise.
  175. .ie !\\n(^b-1 \h'-1.5n'\L'|\\n(^yu-1v'\l'\\n(^lu+3n\(ul'\L'\\n(^tu+1v-\\n(^yu'\h'|0u'\c
  176. .el \h'-1.5n'\L'|\\n(^yu-1v'\h'\\n(^lu+3n'\L'\\n(^tu+1v-\\n(^yu'\h'|0u'\c
  177. .\}
  178. .if \\n(^v \{\
  179. .nr ^x \\n(^tu+1v-\\n(^Yu
  180. \kx\h'-\\nxu'\h'|\\n(^lu+3n'\ky\L'-\\n(^xu'\v'\\n(^xu'\h'|0u'\c
  181. .\}
  182. .bp
  183. 'fi
  184. .ev
  185. .if \\n(^b \{\
  186. .mk ^y
  187. .nr ^b 2
  188. .\}
  189. .if \\n(^v \{\
  190. .mk ^Y
  191. .\}
  192. ..
  193. '\"    # DS - begin display
  194. .de DS
  195. .RS
  196. .nf
  197. .sp
  198. ..
  199. '\"    # DE - end display
  200. .de DE
  201. .fi
  202. .RE
  203. .sp .5
  204. ..
  205. .HS exec tcl 7.0
  206. .BS
  207. '\" Note:  do not modify the .SH NAME line immediately below!
  208. .SH NAME
  209. exec \- Invoke subprocess(es)
  210. .SH SYNOPSIS
  211. \fBexec \fR?\fIswitches\fR? \fIarg \fR?\fIarg ...\fR?
  212. .BE
  213.  
  214. .SH DESCRIPTION
  215. .PP
  216. This command treats its arguments as the specification
  217. of one or more subprocesses to execute.
  218. The arguments take the form of a standard shell pipeline
  219. where each \fIarg\fR becomes one word of a command, and
  220. each distinct command becomes a subprocess.
  221. .PP
  222. If the initial arguments to \fBexec\fR start with \fB\-\fR then
  223. .VS
  224. they are treated as command-line switches and are not part
  225. of the pipeline specification.  The following switches are
  226. currently supported:
  227. .TP 13
  228. \fB\-keepnewline
  229. Retains a trailing newline in the pipeline's output.
  230. Normally a trailing newline will be deleted.
  231. .TP 13
  232. \fB\-\|\-\fR
  233. Marks the end of switches.  The argument following this one will
  234. be treated as the first \fIarg\fR even if it starts with a \fB\-.
  235. .VE
  236. .PP
  237. If an \fIarg\fR (or pair of \fIarg\fR's) has one of the forms
  238. described below then it is used by \fBexec\fR to control the
  239. flow of input and output among the subprocess(es).
  240. Such arguments will not be passed to the subprocess(es).  In forms
  241. .VS
  242. such as ``< \fIfileName\fR'' \fIfileName\fR may either be in a
  243. separate argument from ``<'' or in the same argument with no
  244. intervening space (i.e. ``<\fIfileName\fR'').
  245. .VE
  246. .TP 15
  247. |\fR
  248. Separates distinct commands in the pipeline.  The standard output
  249. of the preceding command will be piped into the standard input
  250. of the next command.
  251. .TP 15
  252. |&\fR
  253. Separates distinct commands in the pipeline.  Both standard output
  254. and standard error of the preceding command will be piped into
  255. the standard input of the next command.
  256. This form of redirection overrides forms such as 2> and >&.
  257. .TP 15
  258. <\0\fIfileName\fR
  259. The file named by \fIfileName\fR is opened and used as the standard
  260. input for the first command in the pipeline.
  261. .TP 15
  262. <@\0\fIfileId\fR
  263. .VS
  264. \fIFileId\fR must be the identifier for an open file, such as the return
  265. value from a previous call to \fBopen\fR.
  266. It is used as the standard input for the first command in the pipeline.
  267. \fIFileId\fR must have been opened for reading.
  268. .VE
  269. .TP 15
  270. <<\0\fIvalue\fR
  271. \fIValue\fR is passed to the first command as its standard input.
  272. .TP 15
  273. >\0\fIfileName\fR
  274. Standard output from the last command is redirected to the file named
  275. \fIfileName\fR, overwriting its previous contents.
  276. .TP 15
  277. 2>\0\fIfileName\fR
  278. .VS
  279. Standard error from all commands in the pipeline is redirected to the
  280. file named \fIfileName\fR, overwriting its previous contents.
  281. .TP 15
  282. >&\0\fIfileName\fR
  283. Both standard output from the last command and standard error from all
  284. commands are redirected to the file named \fIfileName\fR, overwriting
  285. its previous contents.
  286. .VE
  287. .TP 15
  288. >>\0\fIfileName\fR
  289. Standard output from the last command is
  290. redirected to the file named \fIfileName\fR, appending to it rather
  291. than overwriting it.
  292. .TP 15
  293. 2>>\0\fIfileName\fR
  294. .VS
  295. Standard error from all commands in the pipeline is
  296. redirected to the file named \fIfileName\fR, appending to it rather
  297. than overwriting it.
  298. .TP 15
  299. >>&\0\fIfileName\fR
  300. Both standard output from the last command and standard error from
  301. all commands are redirected to the file named \fIfileName\fR,
  302. appending to it rather than overwriting it.
  303. .TP 15
  304. >@\0\fIfileId\fR
  305. \fIFileId\fR must be the identifier for an open file, such as the return
  306. value from a previous call to \fBopen\fR.
  307. Standard output from the last command is redirected to \fIfileId\fR's
  308. file, which must have been opened for writing.
  309. .TP 15
  310. 2>@\0\fIfileId\fR
  311. \fIFileId\fR must be the identifier for an open file, such as the return
  312. value from a previous call to \fBopen\fR.
  313. Standard error from all commands in the pipeline is
  314. redirected to \fIfileId\fR's file.
  315. The file must have been opened for writing.
  316. .TP 15
  317. >&@\0\fIfileId\fR
  318. \fIFileId\fR must be the identifier for an open file, such as the return
  319. value from a previous call to \fBopen\fR.
  320. Both standard output from the last command and standard error from
  321. all commands are redirected to \fIfileId\fR's file.
  322. The file must have been opened for writing.
  323. .VE
  324. .PP
  325. If standard output has not been redirected then the \fBexec\fR
  326. command returns the standard output from the last command
  327. in the pipeline.
  328. If any of the commands in the pipeline exit abnormally or
  329. are killed or suspended, then \fBexec\fR will return an error
  330. and the error message will include the pipeline's output followed by
  331. error messages describing the abnormal terminations; the
  332. \fBerrorCode\fR variable will contain additional information
  333. about the last abnormal termination encountered.
  334. If any of the commands writes to its standard error file and that
  335. standard error isn't redirected,
  336. then \fBexec\fR will return an error;  the error message
  337. will include the pipeline's standard output, followed by messages
  338. about abnormal terminations (if any), followed by the standard error
  339. output.
  340. .PP
  341. If the last character of the result or error message
  342. is a newline then that character is normally deleted
  343. from the result or error message.
  344. This is consistent with other Tcl return values, which don't
  345. normally end with newlines.
  346. .VS
  347. However, if \fB\-keepnewline\fR is specified then the trailing
  348. newline is retained.
  349. .VE
  350. .PP
  351. If standard input isn't redirected with ``<'' or ``<<''
  352. or ``<@'' then the standard input for the first command in the
  353. pipeline is taken from the application's current standard input.
  354. .PP
  355. If the last \fIarg\fR is ``&'' then the pipeline will be
  356. executed in background.
  357. .VS
  358. In this case the \fBexec\fR command will return a list whose
  359. elements are the process identifiers for all of the subprocesses
  360. in the pipeline.
  361. .VE
  362. The standard output from the last command in the pipeline will
  363. go to the application's standard output if it hasn't been
  364. redirected, and error output from all of
  365. the commands in the pipeline will go to the application's
  366. standard error file unless redirected.
  367. .PP
  368. The first word in each command is taken as the command name;
  369. tilde-substitution is performed on it, and if the result contains
  370. no slashes then the directories
  371. in the PATH environment variable are searched for
  372. an executable by the given name.
  373. If the name contains a slash then it must refer to an executable
  374. reachable from the current directory.
  375. No ``glob'' expansion or other shell-like substitutions
  376. are performed on the arguments to commands.
  377.  
  378. .SH KEYWORDS
  379. execute, pipeline, redirection, subprocess
  380.